<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <meta http-equiv="Cache-Control" content="max-age=7200" />
    <meta name="generator" content="Hugo 0.70.0" />
    <meta name="description" content="">
    <meta name="buildDate" content="2020-07-30 15:35:12">


    <link rel="shortcut icon" href="https://shardingsphere.apache.org/document/current/img/favicon.png" type="image/x-icon" />

    <title>Contributor Guide :: ShardingSphere</title>
    
    
    <link href="https://shardingsphere.apache.org/community/css/nucleus.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/font-awesome.min.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/hybrid.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/featherlight.min.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/perfect-scrollbar.min.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/auto-complete.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/theme.css?1596123312" rel="stylesheet">
    <link href="https://shardingsphere.apache.org/community/css/hugo-theme.css?1596123312" rel="stylesheet">
    
      <link href="https://shardingsphere.apache.org/community/css/theme-black.css?1596123312" rel="stylesheet">
    

    <script src="https://shardingsphere.apache.org/community/js/jquery-2.x.min.js?1596123312"></script>
    
    <style type="text/css">
      :root #header + #content > #left > #rlblock_left{ 
          display:none !important;
      }
      
    </style>
    

  </head>
  <body class="" data-url="/en/contribute/contributor/">
    <nav id="sidebar" class="">



  <div id="header-wrapper">
    <div id="header">
      <a href="https://shardingsphere.apache.org/"><img src="https://shardingsphere.apache.org/document/current/img/logo_v2.png" /></a>

    </div>
    
  </div>

    <div class="highlightable">
    <ul class="topics">

        
          
          


 
  
    
    <li data-nav-id="/en/contribute/" title="Get Involved" class="dd-item 
        parent
        
        
        ">
      <a href="https://shardingsphere.apache.org/community/en/contribute/">
          <b>1. </b>Get Involved
          
      </a>
      
      
        <ul>
          
          
          
          
        
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/subscribe/" title="Subscribe Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/subscribe/">
        Subscribe Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/contributor/" title="Contributor Guide" class="dd-item active">
        <a href="https://shardingsphere.apache.org/community/en/contribute/contributor/">
        Contributor Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/committer/" title="Committer Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/committer/">
        Committer Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/code-conduct/" title="Code of Conduct" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/code-conduct/">
        Code of Conduct
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/document-contributor/" title="Documents Contributor Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/document-contributor/">
        Documents Contributor Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/release/" title="ShardingSphere Release Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/release/">
        ShardingSphere Release Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/release_ui/" title="ShardingSphere-UI Release Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/release_ui/">
        ShardingSphere-UI Release Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/release-elasticjob/" title="ElasticJob Release Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/release-elasticjob/">
        ElasticJob Release Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/release-elasticjob-ui/" title="ElasticJob-UI Release Guide" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/release-elasticjob-ui/">
        ElasticJob-UI Release Guide
        
        </a>
    </li>
     
  
 

            
          
            
            


 
  
    
      <li data-nav-id="/en/contribute/2fa/" title="2FA" class="dd-item ">
        <a href="https://shardingsphere.apache.org/community/en/contribute/2fa/">
        2FA
        
        </a>
    </li>
     
  
 

            
          
        
        </ul>
              
    </li>
  
 

          
          


 
  
    
    <li data-nav-id="/en/powered-by/" title="Powered By ShardingSphere" class="dd-item 
        
        
        
        ">
      <a href="https://shardingsphere.apache.org/community/en/powered-by/">
          <b>2. </b>Powered By ShardingSphere
          
      </a>
      
              
    </li>
  
 

          
          


 
  
    
    <li data-nav-id="/en/team/" title="Team" class="dd-item 
        
        
        
        ">
      <a href="https://shardingsphere.apache.org/community/en/team/">
          <b>3. </b>Team
          
      </a>
      
              
    </li>
  
 

          
          


 
  
    
    <li data-nav-id="/en/security/" title="security" class="dd-item 
        
        
        
        ">
      <a href="https://shardingsphere.apache.org/community/en/security/">
          <b>4. </b>security
          
      </a>
      
              
    </li>
  
 

          
         
    </ul>

    
    

    
    <section id="prefooter">
      <hr/>
      <ul>
      
        <li>
          <a class="padding">
            <i class="fa fa-fw fa-language"></i>
          <div class="select-style">
            <select id="select-language" onchange="location = this.value;">
          
          
          
              
              
                  
                    
                    
<option id="en" value="/community/en/contribute/contributor/" selected>English</option>
                    
                  
              
                  
              
          
              
              
                  
              
                  
                    
                    
<option id="cn" value="/community/cn/contribute/contributor/">简体中文</option>
                    
                  
              
          
        </select>
        <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
          width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
          <g>
            <g id="arrow-drop-down">
              <polygon points="0,63.75 127.5,191.25 255,63.75 		" />
            </g>
          </g>
        </svg>
        </div>
        </a>
        </li>
       
      
      
      </ul>
    </section>
    
    <section id="footer">
      <p></p>

    </section>
  </div>
</nav>





        <section id="body">
        <div id="overlay"></div>
        <div class="padding highlightable">
              
              <div>
                <div id="top-bar">
                
                
                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
                    <span id="sidebar-toggle-span">
                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
                          <i class="fa fa-bars"></i>
                        </a>
                    </span>
                  
                  <span class="links">
                    
          
          
            
            
          
          
            
            
          
          
            <a href='https://shardingsphere.apache.org/community/en/'>ShardingSphere</a> > <a href='https://shardingsphere.apache.org/community/en/contribute/'>Get Involved</a> > Contributor Guide
          
         
          
         
          
           
                  </span>
                </div>
                
              </div>
            </div>
            

        
          <div id="chapter">
        
        <div id="body-inner">
          

        


<p>You can report a bug, submit a new function enhancement suggestion, or submit a pull request directly.</p>
<h2 id="submit-an-issue">Submit an Issue</h2>
<ul>
<li>Before submitting an issue, please go through a comprehensive search to make sure the problem cannot be solved just by searching.</li>
<li>Check the <a href="https://github.com/apache/shardingsphere/issues">Issue List</a> to make sure the problem is not repeated.</li>
<li><a href="https://github.com/apache/shardingsphere/issues/new/choose">Create</a> a new issue and choose the type of issue.</li>
<li>Define the issue with a clear and descriptive title.</li>
<li>Fill in necessary information according to the template.</li>
<li>Choose a label after issue created, for example: bug，enhancement，discussion.</li>
<li>Please pay attention for your issue, you may need provide more information during discussion.</li>
</ul>
<h2 id="developer-flow">Developer Flow</h2>
<h3 id="fork-shardingsphere-repo">Fork ShardingSphere repo</h3>
<ul>
<li>Fork a <code>ShardingSphere</code> repo to your own repo to work, then setting upstream.</li>
</ul>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">git remote add upstream https://github.com/apache/shardingsphere.git
</code></pre></div><h3 id="choose-issue">Choose Issue</h3>
<ul>
<li>Please choose the issue to be edited. If it is a new issue discovered or a new function enhancement to offer, please create an issue and set the right label for it.</li>
<li>After choosing the relevant issue, please reply with a deadline to indicate that you are working on it.</li>
<li>Find a mentor from the <a href="http://incubator.apache.org/projects/shardingsphere.html">Developer List</a> and he/she will give you feedback about the design and the implementation of function in time.</li>
</ul>
<h3 id="create-branch">Create Branch</h3>
<ul>
<li>Switch to forked master branch, pull codes from upstream, then create a new branch.</li>
</ul>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">git checkout master
git pull upstream master
git checkout -b issueNo
</code></pre></div><p><strong>Notice</strong> ：We will merge PR using squash, commit log will be different form upstream if you use old branch.</p>
<h3 id="coding">Coding</h3>
<ul>
<li>Please obey the <a href="https://shardingsphere.apache.org/community/en/contribute/code-conduct/">Code of Conduct</a> during the process of development and finish the check before submitting the pull request.</li>
<li>push code to your fork repo.</li>
</ul>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">git add modified-file-names
git commit -m <span style="color:#e6db74">&#39;commit log&#39;</span>
git push origin issueNo
</code></pre></div><h3 id="submit-pull-request">Submit Pull Request</h3>
<ul>
<li>Send a pull request to the master branch.</li>
<li>The mentor will do code review before discussing some details (including the design, the implementation and the performance) with you. The request will be merged into the branch of current development version after the edit is well enough.</li>
<li>At last, congratulate to be an official contributor of ShardingSphere</li>
</ul>
<h3 id="delete-branch">Delete Branch</h3>
<ul>
<li>You can delete the remote branch (origin/issueNo) and the local branch (issueNo) associated with the remote branch (origin/issueNo) after the mentor merged the pull request into the master branch of ShardingSphere.</li>
</ul>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">git checkout master
git branch -d issueNo
git push origin --delete issueNo
</code></pre></div><h3 id="notice">Notice</h3>
<p>Please note that in order to show your id in the contributor list, don&rsquo;t forget the configurations below:</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">git config --global user.name <span style="color:#e6db74">&#34;username&#34;</span>
git config --global user.email <span style="color:#e6db74">&#34;username@mail.com&#34;</span>
</code></pre></div>

<footer class=" footline" >
	
</footer>


        
            </div> 
        
        </div> 
        

      </div>

    <div id="navigation">
        
        
        
        
            
            
                
                    
                    
                
                

                    
                    
                        
                    
                    

                    
                        
            
            
                
                    
                    
                
                

                    
                    
                    

                    
                        
            
            
                
                    
                        
                        
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                        
                        
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
                        
            
            
                
                    
                
                

                    
                    
                    

                    
            
        
                    
            
        
        
        


        
            <a class="nav nav-prev" href="https://shardingsphere.apache.org/community/en/contribute/subscribe/" title="Subscribe Guide"> <i class="fa fa-chevron-left"></i></a>
        
        
            <a class="nav nav-next" href="https://shardingsphere.apache.org/community/en/contribute/committer/" title="Committer Guide" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
        
    </div>

    </section>
    
    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
    </div>
    <script src="https://shardingsphere.apache.org/community/js/clipboard.min.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/perfect-scrollbar.min.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/perfect-scrollbar.jquery.min.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/jquery.sticky.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/featherlight.min.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/html5shiv-printshiv.min.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/highlight.pack.js?1596123312"></script>
    <script>hljs.initHighlightingOnLoad();</script>
    <script src="https://shardingsphere.apache.org/community/js/modernizr.custom.71422.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/learn.js?1596123312"></script>
    <script src="https://shardingsphere.apache.org/community/js/hugo-learn.js?1596123312"></script>

    

  </body>
</html>

